'\"macro stdmacro
.\"
.\" Copyright (c) 2011 Aconex.  All Rights Reserved.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.\"
.TH PMDAELASTICSEARCH 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmdaelasticsearch\f1 \- elasticsearch performance metrics domain agent (PMDA)
.SH DESCRIPTION
\f3pmdaelasticsearch\f1 is a Performance Metrics Domain Agent (\s-1PMDA\s0) which
exports performance metrics from elasticsearch.
.SH INSTALLATION
This \s-1PMDA\s0 requires that elasticsearch is running on the local host and
is accepting queries on \s-1TCP\s0 port 9200.
.PP
Install the elasticsearch \s-1PMDA\s0 by using the Install script as root:
.PP
\      # cd $PCP_PMDAS_DIR/elasticsearch
.br
\      # ./Install
.PP
To uninstall, do the following as root:
.PP
\      # cd $PCP_PMDAS_DIR/elasticsearch
.br
\      # ./Remove
.PP
\fBpmdaelasticsearch\fR is launched by \fIpmcd\fR(1) and should never be executed
directly. The Install and Remove scripts notify \fIpmcd\fR(1) when the
agent is installed or removed.
.SH FILES
.IP "\fB$PCP_PMDAS_DIR/elasticsearch/elasticsearch.conf\fR" 4
optional configuration file for \fBpmdaelasticsearch\fR
.IP "\fB$PCP_PMDAS_DIR/elasticsearch/Install\fR" 4
installation script for the \fBpmdaelasticsearch\fR agent
.IP "\fB$PCP_PMDAS_DIR/elasticsearch/Remove\fR" 4
undo installation script for the \fBpmdaelasticsearch\fR agent
.IP "\fB$PCP_LOG_DIR/pmcd/elasticsearch.log\fR" 4
default log file for error messages from \fBpmdaelasticsearch\fR
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fR are used to parameterize
the file and directory names used by \fBPCP\fR. On each installation, the
file \fB/etc/pcp.conf\fR contains the local values for these variables.
The \fB$PCP_CONF\fR variable may be used to specify an alternative
configuration file, as described in \fIpcp.conf\fR(5).
.SH SEE ALSO
.BR PCPIntro (1)
and
.BR pmcd (1).
